[Discounts] Described Discounts API #2783

mnocon · 2025-06-10T22:04:14Z

This PR describes how you can use the Discounts PHP API and the core concepts needed to work with it.

Previews:

github-actions · 2025-06-10T22:13:47Z

Preview of modified files

Preview of modified Markdown:

mnocon · 2025-06-11T07:00:17Z

code_samples/discounts/src/Command/ManageDiscountsCommand.php

+                new IsInRegions(['germany', 'france']),
+                new IsProductInArray(['product-1', 'product-2']),
+                new IsInCurrency('EUR'),
+                new IsValidDiscountCode($discountCode->getCode(), $discountCode->getUsedLimit()),


TBH I'm not sure about the $discountCode->getUsedLimit() part - which value should be passed here, the current usage or the max usage?

If I understand correctly, the condition calls the resolver which takes a single argument - so the second argument to IsValidDiscountCode is actually not used?

Maybe @Steveb-p can clarify, but to me it's the max usage.

mnocon · 2025-06-11T07:35:50Z

code_samples/discounts/src/Command/ManageDiscountsCommand.php

+        $discountCode = $this->discountCodeService->createDiscountCode($discountCodeCreateStruct);
+
+        $discountCreateStruct = new DiscountCreateStruct();
+        $discountCreateStruct->setIdentifier('discount_identifier')


I've chosen the fluent API usage over the constructor, as this is self-documenting for the code sample - I'd just use the constructor in "standard" code.

I hope it will be clear for the readers that they can just use the constructor.

docs/discounts/discounts_api.md

+## Search
+
+You can search for Discounts using the [`DiscountServiceInterface::findDiscounts()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-DiscountServiceInterface.html#method_findDiscounts) method. 
+To learn more about the available search options, see Discounts' Search Criteria and Sort Clauses.


konradoboza

Very solid overall 💪 A few remarks from my end:

code_samples/discounts/src/Command/ManageDiscountsCommand.php

konradoboza · 2025-06-11T07:37:40Z

code_samples/discounts/src/Command/ManageDiscountsCommand.php

+                new IsInRegions(['germany', 'france']),
+                new IsProductInArray(['product-1', 'product-2']),
+                new IsInCurrency('EUR'),
+                new IsValidDiscountCode($discountCode->getCode(), $discountCode->getUsedLimit()),


Maybe @Steveb-p can clarify, but to me it's the max usage.

docs/discounts/discounts_api.md

mnocon · 2025-06-11T08:15:28Z

@konradoboza thank you for your suggestions, I've applied them in e141ad2

Please note that I've added a small note on Discount Statuses.

adriendupuis

I'm lost with expression values and condition Identifiers in REST. Maybe it's only for migration, not REST?

docs/discounts/discounts_api.md

docs/content_management/data_migration/importing_data.md

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

github-actions · 2025-06-15T20:59:48Z

code_samples/ change report

Before (on target branch) After (in current PR)


code_samples/discounts/src/Command/ManageDiscountsCommand.php


code_samples/discounts/src/Command/ManageDiscountsCommand.php

docs/discounts/discounts_api.md@118:``` php hl_lines="60-66 68-92"
docs/discounts/discounts_api.md@119:[[= include_file('code_samples/discounts/src/Command/ManageDiscountsCommand.php') =]]
docs/discounts/discounts_api.md@120:```

001⫶<?php
002⫶
003⫶declare(strict_types=1);
004⫶
005⫶namespace App\Command;
006⫶
007⫶use DateTimeImmutable;
008⫶use Ibexa\Contracts\Core\Collection\ArrayMap;
009⫶use Ibexa\Contracts\Core\Repository\PermissionResolver;
010⫶use Ibexa\Contracts\Core\Repository\UserService;
011⫶use Ibexa\Contracts\Discounts\DiscountServiceInterface;
012⫶use Ibexa\Contracts\Discounts\Value\DiscountType;
013⫶use Ibexa\Contracts\Discounts\Value\Struct\DiscountCreateStruct;
014⫶use Ibexa\Contracts\Discounts\Value\Struct\DiscountTranslationStruct;
015⫶use Ibexa\Contracts\DiscountsCodes\DiscountCodeServiceInterface;
016⫶use Ibexa\Contracts\DiscountsCodes\Value\Struct\DiscountCodeCreateStruct;
017⫶use Ibexa\Discounts\Value\DiscountCondition\IsInCurrency;
018⫶use Ibexa\Discounts\Value\DiscountCondition\IsInRegions;
019⫶use Ibexa\Discounts\Value\DiscountCondition\IsProductInArray;
020⫶use Ibexa\Discounts\Value\DiscountRule\FixedAmount;
021⫶use Ibexa\DiscountsCodes\Value\DiscountCondition\IsValidDiscountCode;
022⫶use Symfony\Component\Console\Command\Command;
023⫶use Symfony\Component\Console\Input\InputInterface;
024⫶use Symfony\Component\Console\Output\OutputInterface;
025⫶
026⫶final class ManageDiscountsCommand extends Command
027⫶{
028⫶    protected static $defaultName = 'discounts:manage';
029⫶
030⫶    private DiscountServiceInterface $discountService;
031⫶
032⫶    private DiscountCodeServiceInterface $discountCodeService;
033⫶
034⫶    private PermissionResolver $permissionResolver;
035⫶
036⫶    private UserService $userService;
037⫶
038⫶    public function __construct(
039⫶        UserService $userSerice,
040⫶        PermissionResolver $permissionResolver,
041⫶        DiscountServiceInterface $discountService,
042⫶        DiscountCodeServiceInterface $discountCodeService
043⫶    ) {
044⫶        $this->userService = $userSerice;
045⫶        $this->discountService = $discountService;
046⫶        $this->discountCodeService = $discountCodeService;
047⫶        $this->permissionResolver = $permissionResolver;
048⫶
049⫶        parent::__construct();
050⫶    }
051⫶
052⫶    protected function execute(InputInterface $input, OutputInterface $output): int
053⫶    {
054⫶        $this->permissionResolver->setCurrentUserReference(
055⫶            $this->userService->loadUserByLogin('admin')
056⫶        );
057⫶
058⫶        $now = new DateTimeImmutable();
059⫶
060❇️        $discountCodeCreateStruct = new DiscountCodeCreateStruct(
061❇️            'summer10',
062❇️            null, // Unlimited usage
063❇️            $this->permissionResolver->getCurrentUserReference()->getUserId(),
064❇️            $now
065❇️        );
066❇️        $discountCode = $this->discountCodeService->createDiscountCode($discountCodeCreateStruct);
067⫶
068❇️        $discountCreateStruct = new DiscountCreateStruct();
069❇️        $discountCreateStruct
070❇️            ->setIdentifier('discount_identifier')
071❇️            ->setType(DiscountType::CART)
072❇️            ->setPriority(10)
073❇️            ->setEnabled(true)
074❇️            ->setUser($this->userService->loadUserByLogin('admin'))
075❇️            ->setRule(new FixedAmount(10))
076❇️            ->setStartDate($now)
077❇️            ->setConditions([
078❇️                new IsInRegions(['germany', 'france']),
079❇️                new IsProductInArray(['product-1', 'product-2']),
080❇️                new IsInCurrency('EUR'),
081❇️                new IsValidDiscountCode($discountCode->getCode(), $discountCode->getUsedLimit()),
082❇️            ])
083❇️            ->setTranslations([
084❇️                new DiscountTranslationStruct('eng-GB', 'Discount name', 'This is a discount description', 'Promotion Label', 'Promotion Description'),
085❇️                new DiscountTranslationStruct('ger-DE', 'Discount name (German)', 'Description (German)', 'Promotion Label (German)', 'Promotion Description (German)'),
086❇️            ])
087❇️            ->setEndDate(null) // Permanent discount
088❇️            ->setCreatedAt($now)
089❇️            ->setUpdatedAt($now)
090❇️            ->setContext(new ArrayMap(['custom_context' => 'custom_value']));
091❇️
092❇️        $this->discountService->createDiscount($discountCreateStruct);
093⫶
094⫶        return Command::SUCCESS;
095⫶    }
096⫶}

Download colorized diff

* [Discounts] Described Discounts API (#2783) * [Discounts] Configuration (#2781) --------- Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

mnocon changed the base branch from discounts to discounts-rest June 10, 2025 22:11

mnocon force-pushed the discounts-rest branch from 35978c8 to 636c53c Compare June 10, 2025 22:12

mnocon marked this pull request as ready for review June 11, 2025 06:41

mnocon added the Needs DEV review label Jun 11, 2025

mnocon requested review from Steveb-p and konradoboza June 11, 2025 06:41

mnocon commented Jun 11, 2025

View reviewed changes

docs/discounts/discounts_api.md Outdated Show resolved Hide resolved

mnocon commented Jun 11, 2025

View reviewed changes

konradoboza reviewed Jun 11, 2025

View reviewed changes

mnocon force-pushed the discounts-rest branch from 7583a7d to eed2aed Compare June 11, 2025 07:53

mnocon force-pushed the discounts-api branch from bc9b5bd to e141ad2 Compare June 11, 2025 08:13

mnocon requested a review from konradoboza June 11, 2025 08:15

konradoboza approved these changes Jun 11, 2025

View reviewed changes

mnocon added Needs DOC review and removed Needs DEV review labels Jun 11, 2025

mnocon requested a review from a team June 11, 2025 08:26

ezrobot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team June 11, 2025 08:26

mnocon force-pushed the discounts-rest branch from eed2aed to 01e4593 Compare June 11, 2025 11:09

mnocon added 2 commits June 11, 2025 13:11

[Discounts] Described Discounts API

9b88c82

Review fixes

0cd5ae4

mnocon force-pushed the discounts-api branch from e141ad2 to 0cd5ae4 Compare June 11, 2025 11:13

adriendupuis reviewed Jun 13, 2025

View reviewed changes

mnocon commented Jun 13, 2025

View reviewed changes

docs/content_management/data_migration/importing_data.md Outdated Show resolved Hide resolved

Apply suggestions from code review

792252b

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

adriendupuis approved these changes Jun 16, 2025

View reviewed changes

adriendupuis merged commit ca47e18 into discounts-rest Jun 16, 2025
7 checks passed

adriendupuis deleted the discounts-api branch June 16, 2025 07:42

adriendupuis added a commit that referenced this pull request Jun 16, 2025

[Discounts] REST API (#2780)

e531aa3

* [Discounts] Described Discounts API (#2783) * [Discounts] Configuration (#2781) --------- Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

adriendupuis added a commit that referenced this pull request Jun 16, 2025

[Discounts] REST API (#2780)

4686000

* [Discounts] Described Discounts API (#2783) * [Discounts] Configuration (#2781) --------- Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

[Discounts] Described Discounts API #2783

[Discounts] Described Discounts API #2783

Uh oh!

Conversation

mnocon commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 10, 2025

Preview of modified files

Uh oh!

mnocon Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

konradoboza Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

mnocon Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

konradoboza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

konradoboza Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mnocon commented Jun 11, 2025

Uh oh!

adriendupuis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 15, 2025

code_samples/ change report

Uh oh!

Uh oh!

Uh oh!

mnocon commented Jun 10, 2025 •

edited

Loading

mnocon Jun 11, 2025 •

edited

Loading